ApiWorksheet
Represents the ApiWorksheet class.
Properties
Name | Type | Description |
---|---|---|
Visible | boolean | Returns or sets the state of sheet visibility. |
Active | number | Makes the current sheet active. |
ActiveCell | ApiRange | Returns an object that represents an active cell. |
Selection | ApiRange | Returns an object that represents the selected range. |
Cells | ApiRange | Returns ApiRange that represents all the cells on the worksheet (not just the cells that are currently in use). |
Rows | ApiRange | Returns ApiRange that represents all the cells of the rows range. |
Cols | ApiRange | Returns ApiRange that represents all the cells of the columns range. |
UsedRange | ApiRange | Returns ApiRange that represents the used range on the specified worksheet. |
Name | string | Returns or sets a name of the active sheet. |
Index | number | Returns a sheet index. |
LeftMargin | number | Returns or sets the size of the sheet left margin measured in points. |
RightMargin | number | Returns or sets the size of the sheet right margin measured in points. |
TopMargin | number | Returns or sets the size of the sheet top margin measured in points. |
BottomMargin | number | Returns or sets the size of the sheet bottom margin measured in points. |
PageOrientation | PageOrientation | Returns or sets the page orientation. |
PrintHeadings | boolean | Returns or sets the page PrintHeadings property. |
PrintGridlines | boolean | Returns or sets the page PrintGridlines property. |
Defnames | Array | Returns an array of the ApiName objects. |
Comments | Array | Returns all comments from the current worksheet. |
FreezePanes | ApiFreezePanes | Returns the freeze panes for the current worksheet. |
AllProtectedRanges | ApiProtectedRange[] | Returns all protected ranges from the current worksheet. |
PivotTables | ApiPivotTable[] | Returns all pivot tables from the current worksheet. |
Methods
- GetVisible
- SetVisible
- SetActive
- GetActiveCell
- GetSelection
- GetCells
- GetRows
- GetCols
- GetUsedRange
- GetName
- SetName
- GetIndex
- GetRange
- GetRangeByNumber
- FormatAsTable
- SetColumnWidth
- SetRowHeight
- SetDisplayGridlines
- SetDisplayHeadings
- SetLeftMargin
- GetLeftMargin
- SetRightMargin
- GetRightMargin
- SetTopMargin
- GetTopMargin
- SetBottomMargin
- GetBottomMargin
- SetPageOrientation
- GetPageOrientation
- GetPrintHeadings
- SetPrintHeadings
- GetPrintGridlines
- SetPrintGridlines
- GetDefNames
- GetDefName
- AddDefName
- GetComments
- Delete
- SetHyperlink
- AddChart
- AddShape
- AddImage
- GroupDrawings
- AddWordArt
- AddOleObject
- ReplaceCurrentImage
- GetAllDrawings
- GetAllImages
- GetAllShapes
- GetAllCharts
- GetAllOleObjects
- Move
- GetPivotByName
- GetAllPivotTables
- RefreshAllPivots
- GetFreezePanes
- AddProtectedRange
- GetProtectedRange
- GetAllProtectedRanges
- Paste